home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 January: Mac OS SDK / Dev.CD Jan 97 SDK2.toast / Development Kits (Disc 2) / OpenDoc Development Framework / ODFDev / ODF / Tools / Mac / CWPPCProfiler / FWProfiler.h < prev    next >
Encoding:
Text File  |  1996-09-17  |  1.7 KB  |  60 lines  |  [TEXT/MPS ]
  1.  
  2. //========================================================================================
  3. //
  4. //    File:                FWProfiler.h
  5. //    Release Version:    $ ODF 2 $ 
  6. //
  7. //    Copyright:    (c) 1993-1996 by Apple Computer, Inc., all rights reserved.
  8. //
  9. //========================================================================================
  10.  
  11. #ifndef FWPROFILER_H
  12. #define FWPROFILER_H
  13.  
  14. #ifndef __TYPES__
  15. #include <Types.h>
  16. #endif
  17.  
  18. #ifdef __cplusplus
  19. extern "C" {
  20. #endif
  21.  
  22. short FW_ProfilerGetStatus();
  23.     // get the on/off status of the profiler
  24.     
  25. void FW_ProfilerSetStatus(short on);
  26.     // set the on/off status of the profiler
  27.  
  28. void FW_ProfilerSetDumpFile(ConstStr255Param newPath);
  29.     // note: newPath is a length-prefixed pascal string
  30.     // optionally specify the file to output subsequent dumps
  31.     // into. If no file is specified, data will be dumped
  32.     // into a file called "ODFProfiler Dump" at the root of
  33.     // the boot volume. If the file already exists, a number
  34.     // is automatically appended and incremented.
  35.     
  36. void FW_ProfilerUseDefaultDumpFile();
  37.     // reset the dump file to its default value
  38.  
  39. OSErr FW_ProfilerDump();
  40.     // dump the profiler buffer into the current dump file.
  41.     // this does not clear the profile information.
  42.     
  43. void FW_ProfilerClear();
  44.     // clear the profile buffer. this does not affect
  45.     // the on/off status of the profiler. 
  46.     
  47. /* 
  48.     Note to thread users: The ODF interface to CW profiling does
  49.     not provide explicit support for threads. If you need to
  50.     interact with the profiler's thread interface, include
  51.     the Metrowerks header "Profiler.h" and call the thread
  52.     methods directly. The thread-related interfaces are exported
  53.     from the ODFCWProfilerLib to enable this.
  54. */
  55.  
  56. #ifdef __cplusplus
  57. }
  58. #endif
  59.  
  60. #endif